<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class ModifyMode</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class ModifyMode</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
											<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Contains modification modes deciding how to modify a query based on an  <a href="../sde_fastsearch_result/IModifier.html">IModifier</a> and an <a href="../sde_fastsearch_result/INavigator.html">INavigator</a>.</p>
	<ul class="tags">
				<li><span class="field">author:</span> Andreas Scheerer &lt;<a href="mailto:Andreas.Scheerer@sueddeutsche.de">Andreas.Scheerer@sueddeutsche.de</a>&gt;</li>
				<li><span class="field">version:</span> $Id: ModifyMode.html 14 2009-08-23 04:31:36Z andreas.scheerer $</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_src---sde---fastsearch---navigation---ModifyMode.php.html">/src/sde/fastsearch/navigation/ModifyMode.php</a> (line <span class="field">33</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>


	<a name="sec-const-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constant Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="const-summary">
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#MODE_BELOW" title="details" class="const-name">MODE_BELOW</a> = 					<span class="var-type"> 3</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#MODE_EXCLUDE" title="details" class="const-name">MODE_EXCLUDE</a> = 					<span class="var-type"> 1</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#MODE_EXCLUDE_ABOVE" title="details" class="const-name">MODE_EXCLUDE_ABOVE</a> = 					<span class="var-type"> 2</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#MODE_INCLUDE" title="details" class="const-name">MODE_INCLUDE</a> = 					<span class="var-type"> 4</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#MODE_INCLUDE_ABOVE" title="details" class="const-name">MODE_INCLUDE_ABOVE</a> = 					<span class="var-type"> 5</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#MODE_INCLUDE_BELOW" title="details" class="const-name">MODE_INCLUDE_BELOW</a> = 					<span class="var-type"> 6</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#MODE_UNKNOWN" title="details" class="const-name">MODE_UNKNOWN</a> = 					<span class="var-type"> 0</span>

				</div>
							</div>
		</div>
	</div>


	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
									<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
										
				<div class="method-definition">
					static 						<span class="method-result">string</span>
										<a href="#getModeString" title="details" class="method-name">getModeString</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$mode</span>)
									</div>
														
				<div class="method-definition">
					static 						<span class="method-result">boolean</span>
										<a href="#isValidMode" title="details" class="method-name">isValidMode</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$mode</span>)
									</div>
																															</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
										<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodgetModeString" id="getModeString"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static getModeString</span> (line <span class="line-number">114</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a string representing the given mode.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">string</span>
		<span class="method-name">
			getModeString
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$mode</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$mode</span>			</li>
				</ul>
		
			
	</div>
<a name="methodisValidMode" id="isValidMode"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static isValidMode</span> (line <span class="line-number">104</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks if the given int value representing a modify mode is a valid one.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">boolean</span>
		<span class="method-name">
			isValidMode
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$mode</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$mode</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>

	<a name="sec-consts"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="constMODE_BELOW" id="MODE_BELOW"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">MODE_BELOW</span>
			 = <span class="const-default"> 3</span>
			(line <span class="line-number">56</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Exclude data in and &quot;below&quot; modifier's interval.</p>
	
	
</div>
<a name="constMODE_EXCLUDE" id="MODE_EXCLUDE"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">MODE_EXCLUDE</span>
			 = <span class="const-default"> 1</span>
			(line <span class="line-number">46</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Exclude modifier's interval only.</p>
	
	
</div>
<a name="constMODE_EXCLUDE_ABOVE" id="MODE_EXCLUDE_ABOVE"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">MODE_EXCLUDE_ABOVE</span>
			 = <span class="const-default"> 2</span>
			(line <span class="line-number">51</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Exclude data in and &quot;above&quot; modifier's interval.</p>
	
	
</div>
<a name="constMODE_INCLUDE" id="MODE_INCLUDE"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">MODE_INCLUDE</span>
			 = <span class="const-default"> 4</span>
			(line <span class="line-number">61</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Include modifier's interval only.</p>
	
	
</div>
<a name="constMODE_INCLUDE_ABOVE" id="MODE_INCLUDE_ABOVE"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">MODE_INCLUDE_ABOVE</span>
			 = <span class="const-default"> 5</span>
			(line <span class="line-number">66</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Include data in and &quot;above&quot; modifier's interval.</p>
	
	
</div>
<a name="constMODE_INCLUDE_BELOW" id="MODE_INCLUDE_BELOW"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">MODE_INCLUDE_BELOW</span>
			 = <span class="const-default"> 6</span>
			(line <span class="line-number">71</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Include data in and &quot;below&quot; modifier's interval.</p>
	
	
</div>
<a name="constMODE_UNKNOWN" id="MODE_UNKNOWN"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">MODE_UNKNOWN</span>
			 = <span class="const-default"> 0</span>
			(line <span class="line-number">41</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Unknown modifer.</p>
	
	
</div>
						
		</div>
	</div>

	<p class="notes" id="credit">
		Documentation generated on Sun, 23 Aug 2009 06:30:08 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>